Partilhar via


Manage orders - Gets a product promotion by id.

Obtém detalhes da promoção por id.

GET https://api.partnercenter.microsoft.com/v{version}/productpromotions/{id}
GET https://api.partnercenter.microsoft.com/v{version}/productpromotions/{id}?country={country}

Parâmetros do URI

Name Em Necessário Tipo Description
id
path True

string

O id da promoção.

version
path True

string

country
query

string

O código do país.

Cabeçalho do Pedido

Name Necessário Tipo Description
Authorization True

string

Token de portador de autorização

ms-correlationid

string

Usado para rastrear solicitações internamente. Se um ms-correlationid não for fornecido, o servidor gerará um novo para cada solicitação

MS-CV

string

Usado para rastrear solicitações internamente. Se um MS-CV não for fornecido, o servidor gerará um novo para cada solicitação

ms-requestid

string

Usado para idempotência de solicitações. Se um ms-requestid não for fornecido, o servidor gerará um novo para cada solicitação

Respostas

Name Tipo Description
200 OK

Contracts.V1.Models.ProductPromotion

O pedido foi bem-sucedido. O corpo de resposta conterá os detalhes da promoção.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

400 Bad Request

Havia uma entrada ausente ou inválida. O corpo da resposta fornecerá os detalhes do erro.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

401 Unauthorized

O pedido não foi autenticado. O cliente precisa se autenticar com o serviço de API do parceiro primeiro.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

403 Forbidden

O pedido foi autenticado, mas foi recusado, uma vez que o autor da chamada não tem o direito de o invocar.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

404 Not Found

O recurso não é encontrado ou não está disponível com os parâmetros de entrada fornecidos.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

500 Internal Server Error

O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definições

Name Description
Contracts.V1.Models.ProductPromotion
Contracts.V1.Models.ProductPromotionPricingPolicy
Contracts.V1.Models.ProductPromotionProperties
Contracts.V1.Models.ProductPromotionRequiredProduct
Contracts.V1.Models.ProductPromotionTerm

Contracts.V1.Models.ProductPromotion

Name Tipo Description
description

string

endDate

string

id

string

name

string

properties

Contracts.V1.Models.ProductPromotionProperties

requiredProducts

Contracts.V1.Models.ProductPromotionRequiredProduct[]

startDate

string

Contracts.V1.Models.ProductPromotionPricingPolicy

Name Tipo Description
policyType

string

value

string

Contracts.V1.Models.ProductPromotionProperties

Name Tipo Description
isAutoApplicable

boolean

Contracts.V1.Models.ProductPromotionRequiredProduct

Name Tipo Description
pricingPolicies

Contracts.V1.Models.ProductPromotionPricingPolicy[]

productId

string

skuId

string

term

Contracts.V1.Models.ProductPromotionTerm

Contracts.V1.Models.ProductPromotionTerm

Name Tipo Description
billingCycle

string

duration

string